// Copyright (C) Kumo inc. and its affiliates.
// Author: Jeff.li lijippy@163.com
// All rights reserved.
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published
// by the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
//
#pragma once

#include <pollux/expression/vector_function.h>

namespace kumo::pollux::functions {
    /// Function metadata with 'deterministic' as false, it is used for both
    /// 'makeArrayShuffle' and 'makeArrayShuffleWithCustomSeed'.
    /// To ensure 'makeArrayShuffleWithCustomSeed' generates different sequences
    /// for constant inputs, We need to set 'deterministic' to false to prevent
    /// constant folding.
    exec::VectorFunctionMetadata getMetadataForArrayShuffle();

    std::vector<std::shared_ptr<exec::FunctionSignature> > arrayShuffleSignatures();

    /// Shuffle with rand seed.
    std::shared_ptr<exec::VectorFunction> makeArrayShuffle(
        const std::string &name,
        const std::vector<exec::VectorFunctionArg> &inputArgs,
        const core::QueryConfig &config);

    std::vector<std::shared_ptr<exec::FunctionSignature> >
    arrayShuffleWithCustomSeedSignatures();

    /// Shuffle with custom seed (Spark's behavior).
    std::shared_ptr<exec::VectorFunction> makeArrayShuffleWithCustomSeed(
        const std::string &name,
        const std::vector<exec::VectorFunctionArg> &inputArgs,
        const core::QueryConfig &config);
} // namespace kumo::pollux::functions
